home *** CD-ROM | disk | FTP | other *** search
/ By Popular Request 2.0 / By Popular Request 2.0 (Arsenal Computer).ISO / amiga_4 / ipdial13.ads < prev    next >
Text File  |  1995-04-03  |  8KB  |  249 lines
  1.                Amiga Distribution System - Long Description File
  2.                -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  3.  
  4.  
  5.  Program Name : IPDial  - by -  Jochen Wiedmann
  6.  
  7. -----------------------------------------------------------------------------
  8. File 1 - IPDial13.lha -   46525      ADOS Req'd
  9. File 2 -              -       0     [ ] All  [ ] WB1.x  [X] WB2.x  [ ] WB3.x
  10. File 3 -              -       0      ChipSet Req'd
  11. File 4 -              -       0     [X] Any  [ ] Orig   [ ] ECS    [ ] AGA
  12. -----------------------------------------------------------------------------
  13.  
  14.  Ram Req'd 
  15.  
  16.   [X] 512k  [ ] 1meg  [ ] 2meg  [ ] 3meg  [ ] ALOT!!! 
  17.  
  18.  Special Hardware 
  19.  
  20.   
  21.  
  22. -----------------------------------------------------------------------------
  23.                               Long Description
  24. -----------------------------------------------------------------------------
  25.  
  26. Short:    SLIP dialer; stdin/out terminal program
  27. Author:   jochen.wiedmann@zdv.uni-tuebingen.de
  28. Uploader: jochen.wiedmann@zdv.uni-tuebingen.de
  29. Type:     comm/tcp
  30.  
  31.  
  32. IPDial - serial device communication program
  33. ============================================
  34.  
  35.  
  36. IPDial is designed especially for creating a SLIP connection via the
  37. modem to a remote host: It can dial the remote hosts number, login
  38. into the host and initilize a SLIP connection. Configuring IPDial
  39. is rather easy, as it reads its command from a textfile.
  40.  
  41. IPDial is best used from AmiTCP's startnet and stopnet scripts. This
  42. allows you to completely connect or disconnect by just typing the
  43. words "startnet" or "stopnet", respectively.
  44.  
  45.  
  46. 1.) Disclaimer: Copyrights, (No) Warranty
  47. -----------------------------------------
  48.  
  49. This program is Copyright (C) 1994  Jochen Wiedmann
  50.                     Am Eisteich 9
  51.                     72555 Metzingen
  52.                     Germany
  53.  
  54.                     Phone: (0049) +7123 / 14881
  55.                     Mail: jochen.wiedmann@uni-tuebingen.de
  56.  
  57.  
  58. Permission is granted to make and distribute either verbatim and modified
  59. copies of this documentation and the program IPDial provided the copyright
  60. notice and this permission notice are preserved on all copies and the "GNU
  61. General Public License" (in the file COPYING) is distributed as well.
  62.  
  63. The author gives ABSOLUTELY NO warranty that the program described in this
  64. documentation and the results produced by them are correct. The author
  65. cannot be held responsible for ANY damage resulting from the use of this
  66. software.
  67.  
  68.  
  69. 2.) Installation
  70. ----------------
  71.  
  72. Rather simple. Just copy the program to a place in your path and edit
  73. the two files "login.script" and "hangup.script". (See Script file
  74. syntax below for details.)
  75.  
  76. You might want to enter the line
  77.  
  78.     IPDial login.script
  79.  
  80. at the beginning of AmiTCP's startnet script. Thus you get a SLIP
  81. connection by simply typing startnet.
  82.  
  83. Similar you could add the line
  84.  
  85.     IPDial hangup.script
  86.  
  87. at the bottom of the stopnet script.
  88.  
  89.  
  90. 3.) Invocation
  91. --------------
  92.  
  93. IPDial is started like this:
  94.  
  95.     IPDial SCRIPT,ECHO/S,VERBOSE/S,TERMINAL/S,DEVICE/K,PROTOCOL/K,UNIT/K/N
  96.  
  97. What IPDial does, depends on the TERMINAL switch: If this is active,
  98. the arguments DEVICE, UNIT and PROTOCOL are used to open the
  99. serial.device. Once it is opened, the program acts as a very simple
  100. terminal program.
  101.  
  102. If TERMINAL is omitted, the given SCRIPT is read and the commands
  103. of the script are executed line by line. (See below) The argument
  104. ECHO instructs IPDial to print the modems replies to stdout, while
  105. VERBOSE is used to show what the program's doing.
  106.  
  107.  
  108. 4.) Script file syntax
  109. ----------------------
  110.  
  111. - Any line of the script file may contain only one command. In
  112.   general command arguments are parsed with ReadArgs(), thus they
  113.   may look like CLI command line arguments: The characters "" may
  114.   surround a string which contains blanks.
  115.  
  116. - Empty lines or lines beginning with a semicolon are assumed to
  117.   be comments and thus ignored.
  118.  
  119. - Lines may begin with a label, an alphanumeric word followed by
  120.   a colon. Labels are ignored, except that they may be used as
  121.   destinations for "goto" instructions. (Anyone said BASIC? Yes,
  122.   it is. :-) Labels are case-sensitive.
  123.  
  124. - This is the list of possible commands:
  125.  
  126.     DEVICE NAME/A,PROTOCOL,UNIT/K/N
  127.     Opens the given device NAME with unit UNIT (Default 0).
  128.     This must be compatible to the serial.device. PROTOCOL
  129.     may be one of XONXOFF, RTSCTS, 7WIRE (Synonym for RTSCTS)
  130.     or NONE. Note that explicitly requesting a protocol
  131.     overwrites the defaults set by the Derial preferences
  132.     program.
  133.  
  134.     The DEVICE command should in general be the first command
  135.     of each script.
  136.  
  137.     SET BAUD/N/K,DATABITS/N/K,STOPBITS/N/K,BUFSIZE/N/K,PARITY/K
  138.     This command is used to modify the serial.device parameters.
  139.     Note, that these overwrite the Serial preferences. Possible
  140.     parameters are:
  141.         BAUD    baud rate
  142.         DATABITS    number of databits
  143.         STOPBITS    number of stopbits
  144.         BUFSIZE    read buffer size
  145.         PARITY    one of ODD, EVEN or NONE
  146.  
  147.     SHOWPARMS
  148.     Writes the current serial.device settings to stdout.
  149.  
  150.     ECHO ARGS/M
  151.     This will write the given ARGS to stdout. Note, that these
  152.     strings may contain patterns like \r (Carriage Return),
  153.     \n (Line Feed) and \\ (Backslash :-) The arguments are
  154.     separated by blanks, when they are printed.
  155.  
  156.     Note that ECHO does not write any Line Feeds or Carriage
  157.     Returns unless you explicitly request it with the respective
  158.     patterns.
  159.  
  160.     SEND ARGS/M
  161.     This command sends the given strings to the serial.device
  162.     using DoIO(). These strings may contain the same patterns
  163.     as described with the ECHO command. Unlike ECHO the arguments
  164.     aren't separeted by blanks.
  165.  
  166.     The words given with ARGS may contain patterns like $HOST or
  167.     ${HOST}: These are replaced by the respective environment
  168.     variable. (Empty string, if the variable doesn't exist.)
  169.     $$ represents the $ character itself.
  170.  
  171.     DELAY SECS/A
  172.     Delays the given number of seconds.
  173.  
  174.     WAIT TIMEOUT/K/N/A,ARGS/M
  175.     This command waits until either one of the given strings
  176.     is read from the serial.device or the number of seconds
  177.     given by TIMEOUT has gone.
  178.  
  179.     A variable called STATUS indicates what happened: It contains
  180.     either -1 for timeout or the number of the string that was
  181.     read, beginning with 0. This variable may be used by the
  182.     ON statement.
  183.  
  184.     ON STATUS GOTO LABELS/M
  185.     There's currently only one version of the ON command.
  186.     An ON command must follow a WAIT command. ON reads the
  187.     value of the STATUS variable and jumps to the first
  188.     one, if STATUS is -1, to the second, if STATUS is 0 and
  189.     so on. A typical use of WAIT/ON looks like this:
  190.  
  191.         WAIT TIMEOUT=10 "Login:" "Busy"
  192.         ON STATUS GOTO TimeOut Login Busy
  193.  
  194.         TimeOut:
  195.         ECHO "Timeout happened, aborting.\n"
  196.         EXIT 10
  197.  
  198.         Busy:
  199.         ECHO "Remote busy, delaying...\n"
  200.         DELAY 25
  201.         ECHO "Trying again.\n"
  202.         GOTO DialAgain
  203.  
  204.         Login:
  205.         ;    Execute the login procedure
  206.  
  207.     You do not need to supply a label for any wait string:
  208.     This will suppress jumping and instead continue on
  209.     the next line.
  210.  
  211.     GOTO LABEL/A
  212.     Jumps to the given label
  213.  
  214.     TERMINAL
  215.     Enters terminal mode: What you enter at the keyboard will
  216.     be sent to the serial.device and likewise the program will
  217.     display any input from the serial.device to you. The
  218.     TERMINAL command will be finished, if you enter EOF
  219.     (Ctrl-\).
  220.  
  221.     EXIT RESULT
  222.     Terminates the program, returns the given RESULT. (Defaults
  223.     to 0.)
  224.  
  225.   Commands are case-insensitive.
  226.  
  227. See the scrips Login.IPDial and Hangup.IPDial as examples.
  228.  
  229.  
  230. =============================================================================
  231.  
  232.            ADS Zone: 1
  233.      ADS Hatch Site: Paul Miller
  234.        ADS Position: ADS Zone 1 STAR
  235.            BBS Name: Lonely Mountain BBS
  236.     Phone Number(s): 804-827-0726
  237.     Network Address: 1:271/292  
  238.      Network Region: 13    
  239.           BBS Hours: 24 Hrs/Day
  240. BBS Mailer/Software: Mebbs-Net Pro BBS
  241.   BBS Storage Space: 2250 Megs + 8 CD Roms
  242.   File Requestable :  <X> Y     < > N
  243. File Request Hours : All The Time
  244.  
  245. =============================================================================
  246.                          ADS - Long Description Generator
  247.                          (c)Copyright 1995 by Paul Miller
  248.  
  249.